Skip to content

Only localize scripts once#2260

Merged
Crabcyborg merged 1 commit into
masterfrom
run-localize-script-once
Feb 25, 2025
Merged

Only localize scripts once#2260
Crabcyborg merged 1 commit into
masterfrom
run-localize-script-once

Conversation

@truongwp

@truongwp truongwp commented Feb 24, 2025

Copy link
Copy Markdown
Contributor

@truongwp
truongwp requested a review from Crabcyborg February 24, 2025 17:59
@coderabbitai

coderabbitai Bot commented Feb 24, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The changes update the FrmAppHelper class in the system by introducing a new static property to track localized script locations. The localize_script method is modified to check if the script for a given location has already been localized and returns immediately if true. If not, it proceeds to localize the script and marks the location as completed to prevent redundant operations.

Changes

File Change Summary
classes/.../FrmAppHelper.php Added private static $localized_script_locations property; updated localize_script to check and mark script localization for given locations.

Sequence Diagram(s)

sequenceDiagram
    participant Caller as Caller
    participant Helper as FrmAppHelper

    Caller->>Helper: Call localize_script($location)
    alt If location is already localized
        Helper-->>Caller: Return early
    else Location not localized
        Helper->>Helper: Localize the script
        Helper->>Helper: Mark location as localized
        Helper-->>Caller: Return after localization
    end
Loading

Suggested labels

run tests

Suggested reviewers

  • Crabcyborg
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b681eb2 and 8db0a72.

📒 Files selected for processing (1)
  • classes/helpers/FrmAppHelper.php (3 hunks)
🔇 Additional comments (2)
classes/helpers/FrmAppHelper.php (2)

39-42: LGTM! Well-structured property definition.

The new static property is well documented and appropriately scoped as private since it's only used internally.

3331-3334: LGTM! Good optimization to prevent duplicate script localization.

The added check prevents redundant localization of scripts for the same location, which can help improve performance. The implementation is clean and maintains the existing functionality while adding the optimization.

Also applies to: 3440-3441

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Crabcyborg
Crabcyborg approved these changes Feb 25, 2025
View reviewed changes

@Crabcyborg Crabcyborg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @truongwp!

I think this should be good.

@Crabcyborg Crabcyborg added this to the 6.19 milestone Feb 25, 2025
@Crabcyborg
Crabcyborg merged commit c799b35 into master Feb 25, 2025
@Crabcyborg
Crabcyborg deleted the run-localize-script-once branch February 25, 2025 20:23
@Crabcyborg Crabcyborg mentioned this pull request Mar 11, 2025
Merged
@Crabcyborg

Crabcyborg commented Mar 11, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

It looks like this is preventing my frm_js global var from working properly.

Reverting for now to prevent bugs in today's release #2268

@Crabcyborg Crabcyborg removed this from the 6.19 milestone Mar 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Crabcyborg Crabcyborg Crabcyborg approved these changes

Assignees

No one assigned

Labels

run analysis run tests

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@truongwp @Crabcyborg